FMS Commands
CygNet Measurement (FMS) commands are the primary mechanism through which you can ask the system to perform a customized task. Command parameters customize the work the system is to perform. FMS commands that are too complex to be configured via simple parameters have a separate configuration interface in the administrative client.
FMS Commands can be executed using the following methods.
- through the FMS Explorer user interface
- through the CygNet Explorer application (either scheduled in the MSS service or executed as a <Quick Command> through the FMS service)
- via ActiveX controls
- via script
Note: Not all commands use all run methods. Those using only specific methods are indicated in the Command Types list.
The service determines the available data for a request, and then retrieves the data. If commands are executed against Nodes that have not been configured to support the requested data, the request will only be sent for the Node(s) that are configured to support the requested data.
The service returns a token for each data collection command, which can be used to track the status of the command being executed. Token-based requests are generally used for scheduled polls of data, requesting all data you don't already have. There are no date/time parameters.
Note: You must have proper security authorization to access certain command functionality. See FMS Security (CMDDEV and CMSSYS security events) for information about configuring security access for FMS commands.
See Using the Commands Menu for more information about utilizing commands via FMS Explorer.
See Scheduling FMS Command Tasks in the MSS for more information about scheduling commands.
See FMS ActiveX Controls and CxHmiFms for more information about using commands via FMS ActiveX controls on CygNet Studio or CygNet Vision screens.
See CxFms for more information about scripting commands.
FMS Command Types
FMS commands include the following, grouped into command types.
Device Communication
- Request Current Configuration
- Request Data
- Request Missing Data
- Request New Data
- Request Product Data
- Send Gas Quality
- Flow-Cal Request Missing Data (if installed; via MSS/scripting only)
- Flow-Cal Send Gas Quality (if installed; via MSS/scripting only)
Export
- Completed Jobs (via MSS/scripting only; operates in conjunction with CygNet Dispatch)
- Device Data CSV (via MSS/scripting only)
- PPAs CSV
- Normalization View Data CSV
- Flow-Cal Data CFX (if installed)
- Flow-Cal Ticket Data TFX (if installed)
- Flow-Cal Transaction Queue (if installed)
- PGAS Data XML (if installed)
Import
- Alarms CSV
- Configuration CSV
- EmersonRoc Laptop File
- Events CSV
- Gas Analysis CSV
- Gas Quality CSV
- History CSV
- Totalflow Laptop File
Reports
- Balance Contribution
- Balance Details
- Balance Overview
- Batch
- Changed Device Data
- Changed Station Data
- Configuration
- Device QTR
- Device Total QTR
- Event
- Gas Analysis
- Gas Device Raw QTR
- Job (operates in conjunction with CygNet Dispatch)
- Late Job (operates in conjunction with CygNet Dispatch)
- Liquid Device QTR
- Liquid Device Raw QTR
- Missing Data
- Missing Data Overview
- Normalization View
- Ticket
System
- Archive Data (if enabled; via MSS/scripting only)
- Detect New Devices
- Estimate Station Data
- Generate Smart Groups
- Perform Database Maintenance
- Precalculate Calibration Data (operates in conjunction with CygNet Dispatch)
- Schedule Jobs (via MSS/scripting only; operates in conjunction with CygNet Dispatch)
- Update Normalization Views
User
- Close Period (via FMS Explorer / FMS ActiveX Controls only)
- Validate Data
See CygNet Measurement Data Calculation for information about calculation functionality utilized by FMS commands.
More:
Scheduling FMS Command Tasks in the MSS
Device Communication: Request Current Configuration
Device Communication: Request Data
Device Communication: Request Missing Data
Device Communication: Request New Data
Device Communication: Request Product Data
Device Communication: Send Gas Quality
Device Communication: Flow-Cal Request Missing Data
Device Communication: Flow-Cal Send Gas Quality
Export: Normalization View Data CSV
Export: Flow-Cal Ticket Data TFX
Export: Flow-Cal Transaction Queue
Import: EmersonRoc Laptop File
Reports: Liquid Device Raw QTR
Reports: Missing Data Overview
System: Perform Database Maintenance
System: Precalculate Calibration Data
System: Update Normalization Views
